/***************************************************************************
 *   mgpi_grbclr.h - Garbage Collector Declarations                        *
 *   Copyright (C) 2008 by cmaster.matso                                   *
 *   cmaster.matso@gmail.com                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#ifndef _GRBCLR_H
#define _GRBCLR_H

#ifdef __cplusplus
extern "C" {
#endif

#include "../../math/src/mgpi_math.h"

#define MGPI_MAX_COLLECTOR_CAPACITY  65536                                      /** max garbage collector capacity */

#pragma pack(push, 1)

    typedef struct _lgarb {
        void *garbage;															/** pointer to "garbage" - data areas to be freed */
        struct _lgarb *next, *prev;
    } lgarb_t;																	/** garbage node */

#pragma pack(pop)

    /**
     * Collects given pointer in the array.
     */
    void MGPI_API MGPI_CollectGarbageA(void *ptr);

    /**
     * Frees all not NULL pointers in the array.
     */
    int MGPI_API MGPI_RemoveGarbageA(void);

    /**
     * Collets given pointer in the list.
     */
    void MGPI_API MGPI_CollectGarbage(void *ptr);

    /**
     * Frees all not NULL pointers from the list.
     */
    int MGPI_API MGPI_RemoveGarbage(void);

#ifdef __cplusplus
}
#endif

#endif

